﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Java Client </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Java Client ">
    <meta name="generator" content="docfx 2.59.2.0">
    
    <link rel="shortcut icon" href="../../../../favicon.ico">
    <link rel="stylesheet" href="../../../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../../../styles/docfx.css">
    <link rel="stylesheet" href="../../../../styles/main.css">
    <link rel="stylesheet" href="../../../../styles/socialbar.css">
    <link rel="stylesheet" href="../../../../styles/header.css">
    <link rel="stylesheet" href="../../../../styles/version.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto:400,100,300,500,700,100italic,300italic,400italic" rel="stylesheet" type="text/css">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
    <meta property="docfx:navrel" content="../../../../toc.html">
    <meta property="docfx:tocrel" content="../../../toc.html">
    <meta property="docfx:uid" content="">
    
    <meta property="docfx:rel" content="../../../../">
    
    <script type="text/javascript" src="../../../../nav.js"></script>
    <script type="text/javascript" src="../../../toc.js"></script>
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <div class="mb-socials-heading" style="height: 40px;">
        	<div class="mb-socials-heading-inner container">
        		<div class="mb-socials-heading-right">
        			<div class="mb-socials-list">
                          
        				<div class="mb-socials-item facebook">
        					<a class="mb-socials-item-link" target="_blank" href="https://facebook.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Facebook</span>
        					</div>
        				</div><div class="mb-socials-item twitter">
        					<a class="mb-socials-item-link" target="_blank" href="https://twitter.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Twitter</span>
        					</div>
        				</div>
        				<div class="mb-socials-item pinterest">
        					<a class="mb-socials-item-link" target="_blank" href="https://www.pinterest.com/emby0240/emby-news/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Pinterest</span>
        					</div>
        				</div>
        				<div class="mb-socials-item tumblr">
        					<a class="mb-socials-item-link" target="_blank" href="https://embyapp.tumblr.com/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Tumblr</span>
        					</div>
        				</div>
        				<div class="mb-socials-item github">
        					<a class="mb-socials-item-link" target="_blank" href="https://github.com/MediaBrowser"></a>
        					<div class="mb-socials-item-popup">
        						<span>GitHub</span>
        					</div>
        				</div><div class="mb-socials-item rss">
        					<a class="mb-socials-item-link" target="_blank" href="https://emby.media/blog.xml"></a>
        					<div class="mb-socials-item-popup">
        						<span>RSS</span>
        					</div>
        				</div>
                          
        			</div>
        		</div>
        	</div>
        </div>
        <div class="container">
        	<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
        		  
        		  <a class="navbar-brand" href="../../../../index.html">
        		    <img id="logo" class="svg" src="../../../../images/emby_dev_logo.png" alt="">
        		  </a>
        		  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
        			<span class="sr-only">Toggle navigation</span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        		  </button>
        		<div class="collapse navbar-collapse" id="navbar">
        			
        			<ul class="nav level1 navbar-nav">
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../../../index.html" title="DEV Home">DEV Home</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../../../doc/index.html" title="Documentation">Documentation</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../../../reference/index.html" title="Reference">Reference</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../../../download/index.html" title="Download">Download</a>
        			      </li>
        			</ul>		</div>
        	</nav>
        </div>
        <div class="nav-overlay d-none"></div>        
        <div class="subnav navbar navbar-default">
          <div class="container">
            <div class="hide-when-search" id="breadcrumb">
        	  <ul class="breadcrumb">
        		<li></li>
        	  </ul>
        	</div>
        
        	<div class="breadcrumpsearch">
        	  <form class="navbar-form navbar-right" role="search" id="search">
        		<div class="form-group">
        		  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
        		</div>
        	  </form>
        	</div>
          </div>
        </div>
      </header>
      <div class="container body-content">
        
        <div id="search-results">
          <div class="search-list">Search Results for <span></span></div>
          <div class="sr-items">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </div>
          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
        </div>
      </div>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">
<h1 id="java-client">Java Client</h1>

<table><tr></tr>
    <tr>
        <th valign="top" align="left">Name</th>
        <td>embyclient-rest-java</td>
    </tr>
    <tr>
        <th valign="top" align="left">Language</th>
        <td>Java</td>
    </tr>
    <tr>
        <th valign="top" align="left">SDK Folder</th>
        <td>SampleCode/RestApi/Clients/Java</td>
    </tr>
</table>
<h2 id="requirements">Requirements</h2>
<p>Building the API client library requires:</p>
<ol>
<li>Java 1.7+</li>
<li>Maven/Gradle</li>
</ol>
<h2 id="installation">Installation</h2>
<p>To install the API client library to your local Maven repository, simply execute:</p>
<pre><code class="lang-shell">mvn clean install
</code></pre>
<p>To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:</p>
<pre><code class="lang-shell">mvn clean deploy
</code></pre>
<p>Refer to the <a href="http://central.sonatype.org/pages/ossrh-guide.html">OSSRH Guide</a> for more information.</p>
<h3 id="maven-users">Maven users</h3>
<p>Add this dependency to your project's POM:</p>
<pre><code class="lang-xml">&lt;dependency&gt;
  &lt;groupId&gt;media.emby&lt;/groupId&gt;
  &lt;artifactId&gt;embyclient-rest-java&lt;/artifactId&gt;
  &lt;version&gt;0.0.0.0&lt;/version&gt;
  &lt;scope&gt;compile&lt;/scope&gt;
&lt;/dependency&gt;
</code></pre>
<h3 id="gradle-users">Gradle users</h3>
<p>Add this dependency to your project's build file:</p>
<pre><code class="lang-groovy">compile &quot;media.emby:embyclient-rest-java:0.0.0.0&quot;
</code></pre>
<h3 id="others">Others</h3>
<p>At first generate the JAR by executing:</p>
<pre><code class="lang-shell">mvn clean package
</code></pre>
<p>Then manually install the following JARs:</p>
<ul>
<li><code>target/embyclient-rest-java-0.0.0.0.jar</code></li>
<li><code>target/lib/*.jar</code></li>
</ul>
<h2 id="getting-started">Getting Started</h2>
<p>Please follow the <a href="#installation">installation</a> instruction and execute the following Java code:</p>
<pre><code class="lang-java">import EmbyClient.*;
import EmbyClient.auth.*;
import io.swagger.client.model.*;
import EmbyClient.Java.ActivityLogServiceApi;

import java.io.File;
import java.util.*;

public class ActivityLogServiceApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: apikeyauth
        ApiKeyAuth apikeyauth = (ApiKeyAuth) defaultClient.getAuthentication(&quot;apikeyauth&quot;);
        apikeyauth.setApiKey(&quot;YOUR API KEY&quot;);
        // Uncomment the following line to set a prefix for the API key, e.g. &quot;Token&quot; (defaults to null)
        //apikeyauth.setApiKeyPrefix(&quot;Token&quot;);


        ActivityLogServiceApi apiInstance = new ActivityLogServiceApi();
        Integer startIndex = 56; // Integer | Optional. The record index to start at. All items with a lower index will be dropped from the results.
        Integer limit = 56; // Integer | Optional. The maximum number of records to return
        String minDate = &quot;minDate_example&quot;; // String | Optional. The minimum date. Format = ISO
        try {
            QueryResultActivityLogEntry result = apiInstance.getSystemActivitylogEntries(startIndex, limit, minDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println(&quot;Exception when calling ActivityLogServiceApi#getSystemActivitylogEntries&quot;);
            e.printStackTrace();
        }
    }
}
</code></pre>
<h2 id="documentation-links">Documentation Links</h2>
<p>For general documentation, please refer to <a href="../../../../doc/restapi/index.html">Accessing Emby Server via REST API</a>.</p>
<p>The available API endpoints are documented in the <a href="../../../../reference/RestAPI.html">REST API Reference</a> section.</p>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <div class="sdkversion Release">
                  SDK <span class="sdkVersionSpan"></span>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>On this Page</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to Top</a>
            </span>
            Copyright 2022 © EMBY LLC.  Please see our <a class="lnk" href="https://emby.media/terms.html">terms of use</a> and <a class="lnk" href="https://emby.media/privacy.html">privacy policy</a>.
            
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../../../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../../../searchIndex.js"></script>
    <script type="text/javascript" src="../../../../styles/lunr.min.js"></script>
    <script type="text/javascript" src="../../../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../../../styles/main.js"></script>
  </body>
</html>
